Skip to content

Add Raw ID annotation.#354

Merged
ggreer merged 1 commit intomainfrom
ggreer/raw-id
Apr 15, 2025
Merged

Add Raw ID annotation.#354
ggreer merged 1 commit intomainfrom
ggreer/raw-id

Conversation

@ggreer
Copy link
Contributor

@ggreer ggreer commented Apr 15, 2025 •
edited by coderabbitai bot
Loading

V1Identifier is used for other stuff, and ExternalID can only be set on resources, so we need yet another thing to keep track of the raw ID that we got from whatever API we were talking to.

Summary by CodeRabbit

  • New Features
    • Introduced a new identifier type for external APIs, allowing representation of raw IDs in the system.
    • Added validation support for the new identifier type, providing structured error messages for future extensibility.

@ggreer
Add Raw ID annotation.
c08995f 
V1Identifier is used for other stuff, and ExternalID can only be set on resources, so we need yet another thing to keep track of the raw ID of the resource that we got from whatever API we were talking to.
@coderabbitai
Copy link

coderabbitai bot commented Apr 15, 2025 •
edited
Loading

Walkthrough

A new Protocol Buffers definition file was introduced, defining a RawId message with a single string field, id. Corresponding Go code was generated to provide validation logic for this message. The Go file includes methods for validating RawId instances, as well as custom error types for reporting validation issues. At present, the validation logic is implemented as a framework, with no active validation rules applied to the id field.

Changes

File(s) Change Summary
proto/c1/connector/v2/annotation_raw_id.proto Added new protobuf definition for RawId message with a single string field id.
pb/c1/connector/v2/annotation_raw_id.pb.validate.go Added generated Go validation logic for RawId, including Validate methods and custom error types.

Poem

In a field of code, a new seed sown,
A RawId message stands alone.
With Go code to check, but rules yet to come,
Errors wait quietly, their work undone.
The framework is ready, validation in sight—
The rabbit hops forward, all changes are right!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 217316c and c08995f.

⛔ Files ignored due to path filters (1)
  • pb/c1/connector/v2/annotation_raw_id.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (2)
  • pb/c1/connector/v2/annotation_raw_id.pb.validate.go (1 hunks)
  • proto/c1/connector/v2/annotation_raw_id.proto (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: go-test (1.23.x, windows-latest)
🔇 Additional comments (2)
proto/c1/connector/v2/annotation_raw_id.proto (1)

1-10: Proto definition is clear and appropriate.

The RawId message is well-defined for its intended purpose. No issues found.

pb/c1/connector/v2/annotation_raw_id.pb.validate.go (1)

1-137: Generated validation code is correct and matches the proto definition.

The validation framework is well-structured and ready for future rules. No issues found.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ggreer ggreer merged commit 54111ab into main Apr 15, 2025
4 checks passed
@ggreer ggreer deleted the ggreer/raw-id branch April 15, 2025 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ggreer